Reference

Endpoint Read [Dynamic Endpoint]

Name

get_[dynamic_endpoint_name]

Description

No description available

Related Tables

[Dynamic Table]

Parameters

Parameter Required Options
Name: Format

Label: Format

Response format
Name: PageSize

Label: PageSize (Keep blank for default)

Number which indicates max rows per response. Keep it blank to use API default vlaue. Read your API documentation to findout default value.
Name: SearchCriteria

Label: Search Criteria

Data filter (e.g. somecolumn -eq 'somevalue' )
Option Value
None
Equal Serach SomeColumn eq 'SomeValue'
Sub String Serach substringof(SomeField,'abc')
Starts With startswith(SomeField, 'abc')
Value Greater Than filter=mynumericfield gt 1234

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing OData Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use OData Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - OData
Read and write OData API data effortlessly. Query, integrate, and manage entities and feeds — almost no coding required.
OData
[Dynamic Table]
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the [Dynamic Table] table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to read [dynamic endpoint]:

API Destination - OData
Read and write OData API data effortlessly. Query, integrate, and manage entities and feeds — almost no coding required.
OData
[Dynamic Table]
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read all records from a JSON OData service table

<p>Gets all rows from the <code>Customers</code> entity set when the service is configured for JSON. Use the table name that matches your OData metadata (entity set name).</p> 

SELECT * FROM Customers

Filter records using server-side criteria

<p>Gets only customers that match the given OData filter expression. The filter is applied on the server. Use the service's filter syntax (e.g. <code>Country -eq 'USA'</code>).</p> 

SELECT * FROM Customers WITH(SearchCriteria='Country eq ''USA''')

get_[dynamic_endpoint_name] endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read all records from a JSON OData service table

<p>Gets all rows from the <code>Customers</code> entity set when the service is configured for JSON. Use the table name that matches your OData metadata (entity set name).</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Customers';

EXEC (@MyQuery) AT [LS_TO_ODATA_IN_GATEWAY];

Filter records using server-side criteria

<p>Gets only customers that match the given OData filter expression. The filter is applied on the server. Use the service's filter syntax (e.g. <code>Country -eq 'USA'</code>).</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Customers WITH(SearchCriteria=''Country eq ''''USA'''''')';

EXEC (@MyQuery) AT [LS_TO_ODATA_IN_GATEWAY];

get_[dynamic_endpoint_name] endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).